Router

Query Messages

note

We will only go through the queries for this contract, as users are not allowed to execute any messages on the Router contract directly. You can read about the Router architecture here

List of queries that can be performed on the Router contract.

GetState

Quries the state of the contract.

pub enum QueryMsg {
    #[returns(StateResponse)]
    GetState {},
}

{"get_state":{}}

The query returns the following response:

pub struct StateResponse {
    pub admin: String,
    pub vlp_code_id: u64,
    pub vcoin_address: Option<Addr>,
    pub locked: bool,
}

Name	Type	Description
admin	`String`	The admin address, which is the only address allowed to call messages on the contract.
vlp_code_id	`u64`	The code_id used to instantiate new VLP contracts on the hub chain.
vcoin_address	`Option<Addr>`	The address of the Virtual Balance contract used by the router.
locked	`bool`	Whether the contract is locked or not.

GetChain

Queries information about the specified chain.

pub enum QueryMsg {
    #[returns(ChainResponse)]
    GetChain { chain_uid: ChainUid },
}

{"get_chain":{"chain_uid":"chainA"}}

Name	String	Description
chain_uid	ChainUid	The unique Id of the chain to get info for.

The query returns the following response:

pub struct ChainResponse {
    pub chain: Chain,
    pub chain_uid: ChainUid,
}

pub struct Chain {
    pub factory_chain_id: String,
    pub factory: String,
    pub from_hub_channel: String,
    pub from_factory_channel: String,
}

Name	Type	Description
factory_chain_id	`String`	The chain Id of the factory.
factory	`String`	The contract address of the factory contract on the specified chain.
from_hub_channel	`String`	The channel Id that connects the hub to the router.
from_factory_channel	`String`	The channel Id that connects the factory to the router.

GetAllChains

Queries information about all the chains connected to the router.

pub enum QueryMsg {
#[returns(AllChainResponse)]
GetAllChains {},
}

{"get_all_chains":{}}

The query returns a vector of ChainResponse each containing information about one chain.

GetVlp

Queries the VLP address for the specified token pair.

pub enum QueryMsg {
   #[returns(VlpResponse)]
    GetVlp { pair: Pair },
}

{
  "get_vlp": {
    "pair": {
      "token_1": "atom",
      "token_2": "osmo"
    }
  }
}

Name	Type	Description
`pair`	`Pair`	The pair of tokens for the query.

The query returns the following response:

pub struct VlpResponse {
    pub vlp: String,
    pub token_1: Token,
    pub token_2: Token,
}

Name	Description
vlp	The contract address of the VLP holding the token pair.
token_1	The Id of the first token in the VLP to fetch.
token_2	The Id of the second token in the VLP to fetch.

GetAllVlps

Queries all the VLP addresses for all token pairs.

pub enum QueryMsg {
  #[returns(AllVlpResponse)]
    GetAllVlps {
        pagination: Pagination<(Token, Token)>,
    },
}

{
  "get_all_vlps": {
    "pagination": {
      "min": ["usdt", "usdc"],
      "max": ["usdc", "dai"],
      "skip": 5,
      "limit": 10
    }
  }
}

Field	Type	Description
`pagination`	`Pagination<(Token, Token)>`	Pagination parameters.

The query returns a vector of VlpResponse each containing information about on VLP.

SimulateSwap

Simulates a swap based on the specified info.

#[returns(SimulateSwapResponse)]
    SimulateSwap(QuerySimulateSwap),

    pub struct QuerySimulateSwap {
    pub asset_in: Token,
    pub amount_in: Uint128,
    pub asset_out: Token,
    pub min_amount_out: Uint128,
    pub swaps: Vec<NextSwapPair>,
}

{
  "simulate_swap": {
    "asset_in": "tokenA",
    "amount_in": "1000000",
    "asset_out": "tokenB",
    "min_amount_out": "950000",
    "swaps": [
      {
        "token_in": "tokenA",
        "token_out": "tokenC"
      },
      {
        "token_in": "tokenC",
        "token_out": "tokenB"
      }
    ]
  }
}

Name	Type	Description
`asset_in`	`Token`	The identifier for the input asset token.
`amount_in`	`Uint128`	The amount of the input asset token.
`asset_out`	`Token`	The identifier for the output asset token.
`min_amount_out`	`Uint128`	The minimum amount of the output asset token.
`swaps`	`Vec<NextSwapPair>`	A list of swap pairs needed to complete the swap.

With the following struct:

/// The next token pair in the swap route
pub struct NextSwapPair {
    pub token_in: Token,
    pub token_out: Token,
}

Name	Type	Description
`token_in`	`Token`	The token Id for the input token in the swap.
`token_out`	`Token`	The token Id for the output token in the swap.

The query returns the following response:

pub struct SimulateSwapResponse {
    pub amount_out: Uint128,
    pub asset_out: Token,
}

Name	Type	Description
`amount_out`	`Uint128`	The amount of the output asset.
`asset_out`	`Token`	The identifier for the output asset token.

SimulateReleaseEscrow

Simulates a request to release the specified token on the specified cross chain addresses.

pub enum QueryMsg {
  #[returns(SimulateEscrowReleaseResponse)]
    SimulateReleaseEscrow {
        token: Token,
        amount: Uint128,
        cross_chain_addresses: Vec<CrossChainUserWithLimit>,
    }
}

{
  "simulate_release_escrow": {
    "token": "usdt",
    "amount": "100000000",
    "cross_chain_addresses": [
      {
        "user": {
          "chain_uid": "nibi",
          "address": "nibi1..."
        },
        "limit": "500000"
      },
      {
        "user": {
          "chain_uid": "ethereum",
          "address": "0xb36ba2..."
        }
      }
    ]
  }
}

Field	Type	Description
token	`Token`	Identifier for the token.
amount	Uint128	Amount of token to be released.
cross_chain_addresses	`Vec<CrossChainUserWithLimit>`	A set of addresses to specify where the tokens should be released. The first element specified in the vector has highest priority and so on. User specifies a limit for each provided address which indicates the amount of funds that should be released to that address. In case there is any leftover funds, they are added to the user's virtual balance for the address that initiated the message. If limit is not specified, then the maximum amount is taken.

QueryTokenEscrows

Returns a list of chain UIDs belonging to the chains that have an escrow with the specified token Id.

pub enum QueryMsg {
     #[returns(TokenEscrowsResponse)]
    QueryTokenEscrows {
        token: Token,
        pagination: Pagination<ChainUid>,
    },

}

{
  "query_token_escrows": {
    "token": "usdt",
    "pagination": {
      "min": "nibiru",
      "max": "ethereum",
      "skip": 3,
      "limit": 20
    }
  }
}

Field	Type	Description
`token`	`Token`	The token identifier for which escrows are being queried.
`pagination`	`Pagination<(ChainUid)>`	Pagination parameters.

The query returns the following response:

pub struct TokenEscrowsResponse {
    pub chains: Vec<TokenEscrowChainResponse>,
}
pub struct TokenEscrowChainResponse {
    pub chain_uid: ChainUid,
    pub balance: Uint128,
}

Field	Type	Description
`chainUid`	`Vec<ChainUid>`	The unique identifiers for the chain that has an escrow containing the specified token.
`balance`	`Uint128`	The amount of tokens in the escrow.

QueryAllTokens

Queries information on all available tokens.

pub enum QueryMsg {
  #[returns(AllTokensResponse)]
   QueryAllTokens { pagination: Pagination<Token> },
}

{
  "query_all_tokens": {
    "pagination": {
      "min": "usdt",
      "max": "usdt",
      "skip": 2,
      "limit": 20
    }
  }
}

Field	Type	Description
`pagination`	`Pagination<(Token)>`	Pagination parameters.

The query returns the following response:

pub struct AllTokensResponse {
    pub tokens: Vec<TokenResponse>,
}


pub struct TokenResponse {
    pub token: Token,
    pub chain_uid: ChainUid,
}

Field	Type	Description
`token`	`Token`	The unique identifier for the token.
`chain_uid`	`ChainUid`	The unique identifier for the chain returned as a string.

Query Messages​

GetState​

GetChain​

GetAllChains​

GetVlp​

GetAllVlps​

SimulateSwap​

SimulateReleaseEscrow​

QueryTokenEscrows​

QueryAllTokens​

Query Messages

GetState

GetChain

GetAllChains

GetVlp

GetAllVlps

SimulateSwap

SimulateReleaseEscrow

QueryTokenEscrows

QueryAllTokens